Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JDK-8297164: Update troff man pages and CheckManPageOptions.java #11223

Conversation

jonathan-gibbons
Copy link
Contributor

@jonathan-gibbons jonathan-gibbons commented Nov 17, 2022

Please review an update for the troff man pages, following the recent update to upgrade to use pandoc 2.19.2
(See https://bugs.openjdk.org/browse/JDK-8297165)

In conjunction with this, one javadoc test also needs to be updated, to work with the new form of output generated by the new version of pandoc.


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8297164: Update troff man pages and CheckManPageOptions.java

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk pull/11223/head:pull/11223
$ git checkout pull/11223

Update a local copy of the PR:
$ git checkout pull/11223
$ git pull https://git.openjdk.org/jdk pull/11223/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 11223

View PR using the GUI difftool:
$ git pr show -t 11223

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/11223.diff

@bridgekeeper
Copy link

bridgekeeper bot commented Nov 17, 2022

👋 Welcome back jjg! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk openjdk bot added the rfr Pull request is ready for review label Nov 17, 2022
@openjdk
Copy link

openjdk bot commented Nov 17, 2022

@jonathan-gibbons The following labels will be automatically applied to this pull request:

  • compiler
  • core-libs
  • hotspot-jfr
  • javadoc
  • kulla
  • net
  • security
  • serviceability

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

@openjdk openjdk bot added javadoc javadoc-dev@openjdk.org serviceability serviceability-dev@openjdk.org security security-dev@openjdk.org core-libs core-libs-dev@openjdk.org net net-dev@openjdk.org compiler compiler-dev@openjdk.org kulla kulla-dev@openjdk.org hotspot-jfr hotspot-jfr-dev@openjdk.org labels Nov 17, 2022
@mlbridge
Copy link

mlbridge bot commented Nov 17, 2022

Webrevs

@dholmes-ora
Copy link
Member

Hi @jonathan-gibbons ,

I notice that in the new version dash characters are no longer escaped as \-, do these still display correctly?

@jonathan-gibbons
Copy link
Contributor Author

jonathan-gibbons commented Nov 18, 2022

Hi @jonathan-gibbons ,

I notice that in the new version dash characters are no longer escaped as \-, do these still display correctly?

Yes, at least in all the files I verified and I have no reason to believe it might be different in any other files.

On a Mac, you can just do man <path-to-file> to render the contents of a troff file. That is how I checked the files that I did.

Copy link
Member

@dholmes-ora dholmes-ora left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks okay.

Thanks for doing this before the end-of-release updates!

@openjdk
Copy link

openjdk bot commented Nov 21, 2022

@jonathan-gibbons this pull request can not be integrated into master due to one or more merge conflicts. To resolve these merge conflicts and update this pull request you can run the following commands in the local repository for your personal fork:

git checkout 8297164.CheckManPageOptions
git fetch https://git.openjdk.org/jdk master
git merge FETCH_HEAD
# resolve conflicts and follow the instructions given by git merge
git commit -m "Merge master"
git push

@openjdk openjdk bot added the merge-conflict Pull request has merge conflict with target branch label Nov 21, 2022
@openjdk
Copy link

openjdk bot commented Nov 21, 2022

@jonathan-gibbons This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8297164: Update troff man pages and CheckManPageOptions.java

Reviewed-by: dholmes

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added ready Pull request is ready to be integrated and removed merge-conflict Pull request has merge conflict with target branch labels Nov 21, 2022
@dfuch
Copy link
Member

dfuch commented Nov 21, 2022

The diffs are a bit difficult to read but I didn't spot anything obviously wrong with jwebserver. I could see that the new compress option was there in jmod man page too. +1.

@jonathan-gibbons
Copy link
Contributor Author

/integrate

@openjdk
Copy link

openjdk bot commented Nov 21, 2022

Going to push as commit 5a45c25.
Since your change was applied there have been 4 commits pushed to the master branch:

  • f12710e: 8288047: Accelerate Poly1305 on x86_64 using AVX512 instructions
  • cd6a203: 8297348: make CONF=xxx should match if xxx is an exact match
  • 817e039: 8297352: configure should check pandoc version
  • 15e2e28: 8297353: Regenerated checked-in html files with new pandoc

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Nov 21, 2022
@openjdk openjdk bot closed this Nov 21, 2022
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Nov 21, 2022
@openjdk
Copy link

openjdk bot commented Nov 21, 2022

@jonathan-gibbons Pushed as commit 5a45c25.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

@jonathan-gibbons jonathan-gibbons deleted the 8297164.CheckManPageOptions branch November 21, 2022 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compiler compiler-dev@openjdk.org core-libs core-libs-dev@openjdk.org hotspot-jfr hotspot-jfr-dev@openjdk.org integrated Pull request has been integrated javadoc javadoc-dev@openjdk.org kulla kulla-dev@openjdk.org net net-dev@openjdk.org security security-dev@openjdk.org serviceability serviceability-dev@openjdk.org
3 participants